Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: routing MsgSubmitMisbehaviour to UpdateClient keeper fn #1188

Conversation

seantking
Copy link
Contributor

Description

closes: #880


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

Copy link
Contributor

@colin-axner colin-axner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs changelog. Also would be good to update the MsgSubmitMisbehaviour as deprecated as well

@@ -79,6 +79,8 @@ func (k Keeper) UpgradeClient(goCtx context.Context, msg *clienttypes.MsgUpgrade
}

// SubmitMisbehaviour defines a rpc handler method for MsgSubmitMisbehaviour.
// Warning: DEPRECATED
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that what you meant @colin-axner ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be good to add a deprecation notice to the proto files for MsgSubmitBehaviour.

Unfortunately protobuf only seems to have the field option [deprecated = true], there isn't any concrete deprecation flags for an entire message type.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah great point, thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done: see #1188 (comment)

@@ -47,11 +47,11 @@ enum ResponseResultType {
option (gogoproto.goproto_enum_prefix) = false;

// Default zero value enumeration
RESPONSE_RESULT_UNSPECIFIED = 0 [(gogoproto.enumvalue_customname) = "UNSPECIFIED"];
RESPONSE_RESULT_TYPE_UNSPECIFIED = 0 [(gogoproto.enumvalue_customname) = "UNSPECIFIED"];
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied over the changes that are on main. There is some linting issues for channel protos on the 02-client-refactor branch that are fixed on main. In order to add the deprecated flag for MsgSubmitMisbehavior I fixed this (the linter was failing otherwise).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 👍 I fixed this on main in #1143 before but I think those changes have been pulled into 02-client-refactor yet.
I think we should probably merge the latest of main in, also includes the fixes for gh actions (link checker)

@seantking seantking force-pushed the sean/issue#880-route-submit-misb-to-update-client branch from 7a14e35 to 614d818 Compare April 1, 2022 15:04
@@ -82,16 +82,17 @@ message MsgUpgradeClientResponse {}

// MsgSubmitMisbehaviour defines an sdk.Msg type that submits Evidence for
// light client misbehaviour.
// Warning: DEPRECATED
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add something like: "Use MsgUpdateClient instead, this will be removed in a future release"

@seantking seantking enabled auto-merge (squash) April 4, 2022 13:57
@seantking seantking merged commit c43af66 into 02-client-refactor Apr 4, 2022
@seantking seantking deleted the sean/issue#880-route-submit-misb-to-update-client branch April 4, 2022 14:30
oshorefueled pushed a commit to ComposableFi/ibc-go that referenced this pull request Aug 9, 2022
…smos#1188)

* refactor: routing MsgSubmitMisbehaviour to UpdateClient keeper fn

* chore: updating changelog and comment for deprecated notice

* fix: channel proto file linter issue + adding deprecated flag to MsgSubmitMisbehavior

* chore: fix changelog
CosmosCar pushed a commit to caelus-labs/ibc-go that referenced this pull request Nov 6, 2023
<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview
Closes: cosmos#1180 
<!-- 
Please provide an explanation of the PR, including the appropriate
context,
background, goal, and rationale. If there is an issue with this
information,
please provide a tl;dr and link the issue. 
-->

## Checklist

<!-- 
Please complete the checklist to ensure that the PR is ready to be
reviewed.

IMPORTANT:
PRs should be left in Draft until the below checklist is completed.
-->

- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [ ] Visual proof for any user facing features like CLI or
documentation updates
- [x] Linked issues closed with keywords
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants